/*
Copyright 2008-2010 Gephi
Authors : Mathieu Bastian <mathieu.bastian@gephi.org>, Andre Panisson <panisson@gmail.com>
Website : http://www.gephi.org

This file is part of Gephi.

DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

Copyright 2011 Gephi Consortium. All rights reserved.

The contents of this file are subject to the terms of either the GNU
General Public License Version 3 only ("GPL") or the Common
Development and Distribution License("CDDL") (collectively, the
"License"). You may not use this file except in compliance with the
License. You can obtain a copy of the License at
http://gephi.org/about/legal/license-notice/
or /cddl-1.0.txt and /gpl-3.0.txt. See the License for the
specific language governing permissions and limitations under the
License.  When distributing the software, include this License Header
Notice in each file and include the License files at
/cddl-1.0.txt and /gpl-3.0.txt. If applicable, add the following below the
License Header, with the fields enclosed by brackets [] replaced by
your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"

If you wish your version of this file to be governed by only the CDDL
or only the GPL Version 3, indicate your decision by adding
"[Contributor] elects to include this software in this distribution
under the [CDDL or GPL Version 3] license." If you do not indicate a
single choice of license, a recipient has the option to distribute
your version of this file under either the CDDL, the GPL Version 3 or
to extend the choice of license to its licensees as provided above.
However, if you add GPL Version 3 code and therefore, elected the GPL
Version 3 license, then the option applies only if the new code is
made subject to such option by the copyright holder.

Contributor(s):

Portions Copyrighted 2011 Gephi Consortium.
 */
package org.gephi.streaming.api;

import java.io.IOException;

/**
 * This interface represents a connection to a stream.
 *
 * @author panisson
 */
public interface StreamingConnection {

    /**
     * This is used to get the URL where this object is connected.
     * @return the URL
     */
    public StreamingEndpoint getStreamingEndpoint();

    /**
     * This is used to get the Report object where information is stored.
     * @return the Report object
     */
    public Report getReport();

    /**
     * This is used to close the connection
     * @throws IOException
     */
    public void close() throws IOException;

    /**
     * This is used to verify if the connection is closed
     * @return true if connection closed, false otherwise
     */
    public boolean isClosed();

    /**
     * This is used to connect to the URL and process asynchronously the
     * events received. A new thread will be created and the process()
     * will be called.
     */
    public void asynchProcess();

    /**
     * This is used to connect to the URL and process the
     * events received. The method returns only when the connection is closed.
     */
    public void process();

    /**
     * Set a listener to asynchronously receive status notifications.
     * @param listener the listener to be notifiedConnection
     */
    public void addStatusListener(StatusListener listener);

    /**
     * Remove the StatusListener from the listeners
     * @param listener the StatusListener to remove
     */
    public void removeStatusListener(StatusListener listener);

    /**
     * This is the listener interface to asynchronously receive status notifications.
     * It should be registered using setStatusListener().
     */
    public interface StatusListener {
        /**
         * Called when the connection is closed
         * @param connection - the connection reference
         */
        public void onConnectionClosed(StreamingConnection connection);
        /**
         * Called when some data is received
         * @param connection - the connection reference
         */
        public void onDataReceived(StreamingConnection connection);
        /**
         * Called when an error occurred
         * @param connection - the connection reference
         */
        public void onError(StreamingConnection connection);
    }

}
